UX improvements: FFI logging, error message fix, Rust stream borrow checks #515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PR Review ChecklistDo not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed. Trivial Change
Code
Architecture
|
dmitrii-ubskii
force-pushed
the
error-ux
branch
from
429ca6e to
616bec2
Compare
dmitrii-ubskii
commented
Nov 3, 2023
| @@ -180,6 +180,7 @@ test_for_each_arg! { | |||
| let age = unwrap_long(age?.map.remove("age").unwrap()); | |||
| assert_eq!(age, 1); | |||
| } | |||
| drop(ages); | |||
There was a problem hiding this comment.
ages (a Stream) now borrows the transaction
Comment on lines
+108
to
+109
| let answer = context.transaction().query().get(&parsed.to_string())?.try_collect::<Vec<_>>().await?; | ||
| context.answer = answer; |
There was a problem hiding this comment.
We should be able to write this on one line, but the borrow checker gets confused by the .await, and thinks that we attempt to borrow context twice at the same time.
Comment on lines
+262
to
+264
| break collector | ||
| .close(ConnectionError::TransactionIsClosedWithErrors(err.message().to_owned())) | ||
| .await |
There was a problem hiding this comment.
Use the correct error message rather than Status::to_string()
Comment on lines
-31
to
-33
| @Nullable | ||
| private final com.vaticle.typedb.driver.jni.Error nativeError; | ||
|
|
There was a problem hiding this comment.
We no longer store the native error and instead just take its message.
Comment on lines
+34
to
+40
| #[no_mangle] | ||
| pub extern "C" fn init_logging() { | ||
| const ENV_VAR: &str = "TYPEDB_DRIVER_LOG_LEVEL"; | ||
| if let Err(err) = env_logger::try_init_from_env(Env::new().filter(ENV_VAR)) { | ||
| warn!("{err}"); | ||
| } | ||
| } |
There was a problem hiding this comment.
This function allows the FFI drivers to initialize the Rust logger. (Rust driver users can do this directly)
dmitrii-ubskii
changed the title
flyingsilverfin
approved these changes
Nov 3, 2023
dmitrii-ubskii
added a commit
to dmitrii-ubskii/typedb-driver
that referenced
this pull request
Jan 8, 2024
…hecks (typedb#515) ## What is the goal of this PR? We improve the UX of Driver usage in several ways: - [Rust/Java/Python] Fix the formatting of error messages received from the server during a transaction. - [Java] Fix native error message formatting. - [Java/Python] Add the ability to enable Rust logging over FFI (resolves typedb#482). - The granularity of the logs is controlled by the `TYPEDB_DRIVER_LOG_LEVEL` environment variable, which can be set to any value of `error` (default), `warn`, `info`, `debug`, or `trace`, in order of increasing verbosity. Setting the value to `"typedb_driver=info"` will show only the typedb-driver messages. - More advanced syntax is described in [the env_logger documentation](https://docs.rs/env_logger/latest/env_logger/index.html#enabling-logging) - [Rust] Network streams now borrow the transaction, so that the transaction can't be mistakenly dropped. (resolves typedb#449)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the goal of this PR?
We improve the UX of Driver usage in several ways:
TYPEDB_DRIVER_LOG_LEVELenvironment variable, which can be set to any value oferror(default),warn,info,debug, ortrace, in order of increasing verbosity. Setting the value to"typedb_driver=info"will show only the typedb-driver messages.